Skip to content

Add datadog tracing support#4

Merged
erickhun merged 5 commits intomasterfrom
task/add-dd-trace-support
Feb 24, 2020
Merged

Add datadog tracing support#4
erickhun merged 5 commits intomasterfrom
task/add-dd-trace-support

Conversation

@erickhun
Copy link
Collaborator

@erickhun erickhun commented Feb 24, 2020

Append trace_id and span_id to the logs.
We use the mixin() function of pino to append traces to the logs.

Pre-Requirement:

The service using the lib will need to also have the dd-trace library installed. If not, nothing will be appended to the logs.

How to initialise the tracer in a service:

import tracer from "dd-trace";
tracer.init({
    hostname: "dd-agent-hostname",
    logInjection: false
});

# then BuffLog will automatically detect instance of `tracer` and inject the `trace_id`/`span_id`

Results:

# outside a request: 
{"level":35,"time":1582527777954,"message":"hello notice","v":1}
{"level":40,"time":1582527777955,"message":"hello warning","v":1}
{"level":50,"time":1582527777955,"message":"hello error","v":1}
{"level":60,"time":1582527777955,"message":"hello critical","v":1}

# during a request: 
Server is listening on port 4000
{"level":35,"time":1582527789115,"dd":{"trace_id":"4471443652644886255","span_id":"8148478562811089665"},"message":"Log via endpoint","v":1}
{"level":35,"time":1582527789116,"dd":{"trace_id":"4471443652644886255","span_id":"8148478562811089665"},"message":"hello notice","v":1}
{"level":40,"time":1582527789117,"dd":{"trace_id":"4471443652644886255","span_id":"8148478562811089665"},"message":"hello warning","v":1}
{"level":50,"time":1582527789117,"dd":{"trace_id":"4471443652644886255","span_id":"8148478562811089665"},"message":"hello error","v":1}
{"level":60,"time":1582527789117,"dd":{"trace_id":"4471443652644886255","span_id":"8148478562811089665"},"message":"hello critical","v":1}

cc @esclapes @colinscape if you have any comments :) ( I also tried to add tests with #3 , but I couldn't figure out yet how to properly test what's sent to stdout )

@erickhun erickhun requested review from esclapes and removed request for esclapes February 24, 2020 07:25
@erickhun erickhun merged commit 22a93db into master Feb 24, 2020
@erickhun erickhun deleted the task/add-dd-trace-support branch February 24, 2020 07:26
esclapes
esclapes reviewed Feb 24, 2020
View reviewed changes
index.ts

tracer.init({
hostname: "dd-agent-hostname",
logInjection: false
Copy link

@esclapes esclapes Feb 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @erickhun,

Curious to know what differences you found between using logInjection: true which supports pino and doing the injection manually like we are doing in this PR. Is the injected data different?

Copy link
Collaborator Author

@erickhun erickhun Feb 24, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@esclapes good one, i've tried to add the traceID with switching the logInjection to true as you said, but it didn't work out of the box 🤔. It's why i've ended up with the manual tracing.

I'm not too sure how we can make it detect by the dd-trace plugin out of the box. but if you have any idea to make that work that'd be awesome.

Copy link

@esclapes esclapes Feb 24, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@erickhun 🤔 my hunch is that it's an issue with the order of the imports. I believe the .init call needs to happen before anything else is imported so that dd-trace has time to monkey patch the supported libraries.

We usually place all the init code in a separate file and then import that file at the top of the index. This is a recent example

Copy link
Collaborator Author

@erickhun erickhun Feb 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@esclapes oh thanks! i'll try this in an other branch. Sorry if that might look obvious, still trying to get up to speed with js 😅

Copy link
Collaborator Author

@erickhun erickhun Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@esclapes implemented in #8

It also worked if we don't do it in an other file 🤔. I think I've perhaps not switched the autoinject parameter properly 🙈

Thanks for your feedbacks, definitely make it easier to use!

Copy link

@esclapes esclapes Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Glad to know that it works! It feels nice to use the dd-trace feature for this, as it will probably be updated with newer features and bug fixes that may not be obvious to us.

💯

@erickhun erickhun mentioned this pull request Feb 25, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@esclapes esclapes esclapes left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@erickhun @esclapes